/*
 * Copyright 2009 Lukasz Wozniak
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at 
 *
 * http://www.apache.org/licenses/LICENSE-2.0 
 *
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and 
 * limitations under the License.
 */
package pl.sind.http;

import java.io.OutputStream;

/**
 * Interface wrapping HTTP requests allowing to use different transport
 * libraries.<br/>
 * This is for internal use, typical yajba user will never need this.
 * 
 * @author Lukasz Wozniak
 * 
 */
public interface RequestWrapper {

	/**
	 * Sets HTTP header field
	 * 
	 * @param name
	 *            header name
	 * @param value
	 *            header value
	 */
	public void setHeader(String name, String value);

	/**
	 * Returns HTTP header
	 * 
	 * @param name
	 *            header to return
	 * 
	 * @return
	 */
	public String getHeader(String name);

	/**
	 * Provides stream to write HTTP request body.
	 * 
	 * @return ready stream.
	 * @throws HttpRequestException
	 */
	public OutputStream getOutputStream() throws HttpRequestException;
}
